﻿#region Copyright(c) 2006 ZO, All right reserved.
// -----------------------------------------------------------------------------
// Copyright(c) 2006 ZO, All right reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//   1.  Redistribution of source code must retain the above copyright notice,
//       this list of conditions and the following disclaimer.
//   2.  Redistribution in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//   3.  The name of the author may not be used to endorse or promote products
//       derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
// EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// -----------------------------------------------------------------------------
#endregion


#region Using directives

using ZO.SmartCore.Helpers;
using ZO.SmartCore.Xml;

#endregion

namespace ZO.SmartCore.Protocols.XMPP.Protocol.Common
{
    /// <summary>
    /// Encapsulates an Info-Query (or iq) element. The "iq" 
    /// is typically used in a "request/response" fashion, to get or set information.
    /// </summary>
    public abstract class BaseInfoQuery : Stanza
    {

        #region Constructors
        /// <summary>
        /// Initializes a new instance of the <see cref="BaseInfoQuery"/> class.
        /// </summary>
        protected BaseInfoQuery()
            : base("iq")
        {
            this.GenerateID();
        } // IQ
        #endregion

        #region Destructor

        #endregion

        #region Fields

        #endregion

        #region Events

        #endregion

        #region Operators

        #endregion

        #region Properties
        /// <summary>
        /// The query Element. Value can also be null which removes the Query tag when existing 
        /// </summary>
        public Element Query
        {
            get
            {
                return this.SelectSingleElement("query");
            }
            set
            {
                if (value != null)
                {
                    this["query"] = value;
                }
                else
                {
                    this.RemoveChildElement("query");
                }
            }
        }

        /// <summary>
        /// possible types (currently) available to an "iq"
        /// </summary>
        public InfoQueryType Type
        {
            get
            {
                Element element1 = this["type"];

                if (element1 == null)
                {
                    return InfoQueryType.Error;
                }
                else
                {
                    switch (element1.Value)
                    {
                        case "get":
                            return InfoQueryType.Get;

                        case "set":
                            return InfoQueryType.Set;

                        case "result":
                            return InfoQueryType.Result;

                        case "error":
                            return InfoQueryType.Error;

                        default:
                            return InfoQueryType.Error;
                    }
                } // else
            }
            set
            {
                this["type"] = new Element("type", ReflectionHelper.GetDescription(value));
            }
        }
 
        #endregion

        #region Methods

        #endregion
    }
}
